# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Sonic Battle Template

game: Sonic Battle
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Sonic Battle: 0.1.5 # Version of the world required for this yaml to work as expected.

Sonic Battle:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  ####################
  # Gameplay Options #
  ####################
  game_goal:
    # Determines what opens up Death Egg in Emerls Holy Summit.
    chaos_emeralds: 50

  start_story:
    # Choose which character's story you want to start with.
    sonic: 50
    tails: 0
    rouge: 0
    knuckles: 0
    amy: 0
    cream: 0
    shadow: 0

  max_lives:
    # Sets the maximum number of KO's or lives characters need/have in battle
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 20
    5: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-20: 0 # random value between 1 and 20

  special_ring_items:
    # If enabled will add 3 'ring' items that will enable the use of special moves
    'false': 50
    'true': 0

  crystal_ring_item:
    # if enabled will add a 'Crystal Ring' item which will prevent the player from using special moves unless the Ichikoro gauge is full
    'false': 50
    'true': 0

  ichikoro_ring_item:
    # if enabled will add a 'Ichikoro Ring' item which will prevent the player from doing one hit KO's from specials until they have the item
    'false': 50
    'true': 0

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  ######################
  # Skill Card Options #
  ######################
  starting_skill_points:
    # Starting Skill Points (Vanilla is 30)
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 20
    # Maximum value is 100
    50: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-20-100: 0 # random value between 20 and 100

  max_skill_points:
    # Sets the maximum skill points you can hold, will be rounded down sometimes. (Vanilla is 500)
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 400
    # Maximum value is 900
    500: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-400-900: 0 # random value between 400 and 900

  skill_point_multiplier:
    # Multiplier for natural skill point gain after battles.
    # 
    # There will always be enough items in the multiworld to reach the SP maximum. 
    # You can enable this option if you still want to be able to grind for SP.
    zero: 50
    vanilla: 0
    double: 0
    quadruple: 0

  start_skills:
    # Start the game with specific skill cards 
    # example: ['Sonic Run','Tails Hop']
    []

  include_skills:
    # Guarantee that listed skills get added into the skill card pool
    # example: ['Sonic Run','Tails Hop']
    []

  include_ultimate_skills:
    # Always include the full set of Ultimate Emerl Cards
    full_set: 50
    normal: 0
    none: 0

  include_skill_support:
    # If enabled will add one random card of each type of support skill
    'false': 50
    'true': 0

  include_skill_combo:
    # If enabled will add one random combo skill card
    'false': 50
    'true': 0

  include_skill_awaken:
    # If enabled will add one random awakened skill card
    'false': 50
    'true': 0

  #########################
  # Randomization Options #
  #########################
  music_random:
    # Shuffles game music
    'false': 50
    'true': 0

  sound_random:
    # Shuffles game sound effects
    'false': 50
    'true': 0

  voice_random:
    # Shuffles game voices
    'false': 50
    'true': 0

  jingle_random:
    # Shuffles game jingles
    'false': 50
    'true': 0

  text_random:
    # Randomizes story text
    'false': 50
    'true': 0

  ###################
  # Palette Options #
  ###################
  color_random:
    # Randomizes some hit effects, shield and healing palettes, 
    # does not randomize characters palettes
    'false': 50
    'true': 0

  sonic_spine_color:
    # These options will change the color pallette for various parts of the characters inside and outside of battle
    # the two random options are different, 
    # the curated options below retain consistency between in battle sprites and out of battle portraits
    # 'random' selects a random option from the list of choices
    # 'random_color' might pick a palette that isn't listed as a choice however these won't be consistent between their inbattle sprites and out of battle portraits
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    teal: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  sonic_eye_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    random_color: 0

  sonic_shoe_color:
    vanilla: 50
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  tails_furshoe_color:
    vanilla: 50
    red: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  tails_eye_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  knuckles_spine_color:
    vanilla: 50
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    dark_red: 0
    gold: 0
    random_color: 0

  knuckles_sock_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  knuckles_eye_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    blue_edit: 0
    random_color: 0

  shadow_fur_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    gray: 0
    random_color: 0

  shadow_highlight_color:
    vanilla: 50
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    red_edit: 0
    random_color: 0

  shadow_chaosmagic_color_1:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    pink: 0
    random_color: 0

  shadow_chaosmagic_color_2:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    random_color: 0

  rouge_breastplate_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink_edit: 0
    random_color: 0

  rouge_clothes_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black_edit: 0
    brighter_gray: 0
    gray_edit: 0
    random_color: 0

  rouge_eyeshadow_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  amy_spine_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    cyan: 0
    random_color: 0

  amy_dress_color:
    vanilla: 50
    orange: 0
    yellow: 0
    green: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  amy_metal_color:
    vanilla: 50
    silver: 0
    random_color: 0

  amy_eye_color:
    vanilla: 50
    random_color: 0

  cream_fur_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    random_color: 0

  cream_clothes_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  cream_cheese_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    random_color: 0

  cream_chao_extremity_color:
    vanilla: 50
    red: 0
    orange: 0
    green: 0
    cyan: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    random_color: 0

  emerl_color_1:
    vanilla: 50
    red: 0
    yellow: 0
    cyan: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    colgate_extra_white: 0
    lime: 0
    neon_green: 0
    random_color: 0

  emerl_color_2:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    forest: 0
    neon_green: 0
    random_color: 0

  emerl_color_3:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    teal: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  emerl_color_4:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    violet: 0
    purple: 0
    pink: 0
    blue_edit: 0
    random_color: 0

  gamma_body_color:
    vanilla: 50
    yellow: 0
    green: 0
    cyan: 0
    teal: 0
    violet: 0
    pink: 0
    gray: 0
    white: 0
    black_e101_beta: 0
    blue_e103_delta: 0
    orange_e104_epsilon: 0
    purple_e105_zeta: 0
    random_color: 0

  gamma_head_color:
    vanilla: 50
    red: 0
    orange: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    random_color: 0

  gamma_exhaust_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    white: 0
    random_color: 0

  chaos_body_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    green: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    cyan: 0
    random_color: 0

  chaos_eye_color:
    vanilla: 50
    red: 0
    orange: 0
    yellow: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    gray: 0
    white: 0
    cyan: 0
    random_color: 0

  eggman_coat_color:
    vanilla: 50
    orange: 0
    yellow: 0
    green: 0
    cyan: 0
    blue: 0
    violet: 0
    purple: 0
    pink: 0
    black: 0
    gray: 0
    white: 0
    random_color: 0

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
